Inside Macintosh: Programming With the Text Encoding Conversion Manager /

Chapter 3 - Text Encoding Converter Reference / Text Encoding Converter Functions

Internet and Regional Text Encoding Names /

TECGetMailTextEncodings

Returns the currently supported mail encoding specifications for a specified region.

pascal OSStatus TECGetMailTextEncodings (
                     RegionCode locale, 
                     TextEncoding availableEncodings[], 
                     ItemCount maxAvailableEncodings, 
                     ItemCount *actualAvailableEncodings);

locale

A Mac OS region code indicating the locale for which you want to obtain encodings. A region code designates a combination of language, writing system, and geographic region; the region may not correspond to a particular country (for example, Swiss French or Arabic).

availableEncodings[]

An array composed of text encoding specifications. On return, the array contains specifications for the currently supported e-mail text encodings in the specified region. To determine how large an array to allocate, use the function TECCountMailTextEncodings (page 80).

maxAvailableEncodings

The number of text encoding specifications the availableEncodings array can contain.

actualAvailableEncodings

A pointer to a value of type ItemCount. On output, this value indicates the number of text encodings the function returned in the availableEncodings array.

function result

A result code. See "Text Encoding Conversion Manager Result Codes" (page 42) for a list of possible values. If other than noErr, then one of the text conversion plug-ins encountered an error when polled by the Text Encoding Converter.

DISCUSSION

The TECGetMailTextEncodings function returns the text encoding specifications currently supported from those that are commonly used for e-mail in the specified region. The text encoding specifications are returned in the array you pass to the function as the availableEncodings parameter, eliminating any duplicate information in the process. Consequently, the number of encodings TECGetMailTextEncodings returns in the availableEncodings array may be fewer than the number of elements you allocated for the array based on your call to TECCountMailTextEncodings (page 80).

SEE ALSO

The function TECCountAvailableTextEncodings (page 66)

The function TECGetAvailableTextEncodings (page 67)

The function TECCountWebTextEncodings (page 77)

The function TECGetTextEncodingFromInternetName (page 76)

The function GetTextEncodingName (page 52)

The region codes section of "Script Manager" in Inside Macintosh: Text